api/v1/projects/{projectno}/comments

Path: api/v1/projects/{projectno}/comments

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH

This endpoint requires an OAuth bearer token, and returns errors in a standard shape. See API Conventions for authentication, error responses and paging, which apply to every endpoint.

The resource type for this endpoint is ContractComment
The identifier is projectno-lineid

Attributes

The ContractComment resource type attributes are as follows:

Read-only — a tick means the value is set by Jim2 and cannot be changed through the API: it is returned in responses, but any value you send for it in a POST or PATCH is rejected.
Attribute names are case-sensitive and must be sent and read exactly as shown. The API mixes capitalisation styles — some names are PascalCase (e.g. Status, CustRef, DateDue) and others camelCase (e.g. dateIn, priceLevel) — so copy each name verbatim rather than assuming one convention. Filter names (in the filter list on the GET example) may differ from the attribute names.
Monetary and quantity values are decimal numbers whose number of decimal places depends on your Jim2 configuration. They are returned as JSON numbers with their scale preserved. Parse them as decimal / fixed-point values, not floating-point, to preserve precision.

Attribute	Type	Read-only	Description
comment	string		The comment text.
modifyDate	string	✓	The modification date and time of the comment in ISO date time format. Timezone is the timezone of the Jim2 server.
modifyInit	string	✓	The initials of the user who last modified the comment.
status	string	✓	The status the parent object was in when the comment was added.

Example GET (Return all)

Path: api/v1/projects/10/comments

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

This is a list. To keep the example readable, only the first item below is written out; the later items have been trimmed down in this documentation. In a real response each item comes back with the data applicable to that record (as described above).

Side-loading related resources with the include query parameter is not supported on list endpoints: an include parameter is ignored here and no included section is returned. To retrieve a related resource, request it directly using the id shown in each item's relationships, or use the single-resource (get by id) endpoint, which does support include.

{
    "data": [
        {
            "id": "10-1",
            "type": "ContractComment",
            "attributes": {
                "status": "Booked",
                "comment": "Customer approved the annual service schedule.",
                "modifyInit": "SYS",
                "modifyDate": "2024-03-25T17:07:23+11:00"
            }
        }
    ]
}

Example GET (Return specific)

Path: api/v1/projects/10/comments/10-1

Response:

{
    "data": {
        "id": "10-1",
        "type": "ContractComment",
        "attributes": {
            "status": "Booked",
            "comment": "Customer approved the annual service schedule.",
            "modifyInit": "SYS",
            "modifyDate": "2024-03-25T17:07:23+11:00"
        },
      "links": {
        "self": "/api/v1/projects/10/comments/10-1"
      }
    }
}

Example POST

Path: api/v1/projects/10/comments

Request:

{
    "data": {
        "type": "ContractComment",
        "attributes": {
            "comment": "Add new comment"
        }
    }
}

Response:

{
    "data": {
        "id": "10-2",
        "type": "ContractComment",
      "attributes": {
        "status": "Booked",
        "comment": "Add new comment",
        "modifyInit": "API",
        "modifyDate": "2021-03-10T11:33:53"
      },
      "links": {
        "self": "/api/v1/projects/10/comments/10-2"
      }
    }
}

Example PATCH

Path: api/v1/projects/10/comments/10-1

Request:

{
    "data": {
        "id": "10-1",
        "type": "ContractComment",
        "attributes": {
            "comment": "Test"
        }
    }
}

Response:

{
    "data": {
        "id": "10-1",
        "type": "ContractComment",
      "attributes": {
        "status": "Booked",
        "comment": "Test",
        "modifyInit": "API",
        "modifyDate": "2021-03-10T11:33:53"
      },
      "links": {
        "self": "/api/v1/projects/10/comments/10-1"
      }
    }
}